Gửi tin nhắn quick reply

PiScale cung cấp API gửi tin nhắn dạng phản hồi nhanh cho Bot.

HTTP request

POST https://{app_id}.api.piscale.com/chat-bot/v1.0/messages

Request body

Ví dụ

{
    "thread_id": "",
    "ext_user_ids": ["6872016393206779"],
    "user_ids": [],
    "body": {
        "text": "Xin chào 👋\nChào mừng bạn đến với hệ sinh thái sản phẩm PiScale 🚀. Rất sẵn sàng được hỗ trợ bạn 🥳\n\nVui lòng lựa chọn theo menu hỗ trợ bên dưới:",
        "metadata": [
            {   
                "type": "quick_reply",
                "quick_reply": {
                    "items": [
                        {
                            "label": "📣 Sản phẩm",
                            "action": {
                                "type":  2,
                                "payload": "product"
                            }
                        },
                        {
                            "label": "📗 Tài liệu giới thiệu",
                            "action": {
                                "type":  2,
                                "payload": "introduce_docs"
                            }
                        },
                        {
                            "label": "Cảm ơn",
                            "action": {
                                "type":  3,
                                "payload": ""
                            }
                        }
                    ]
                }
            }
        ]
    }
}

Tên	Kiểu dữ liệu	Mô tả	Bắt buộc
thread_id	string	Mã cuộc hội thoại	✗
ext_user_ids	array	Danh sách ext_user_id	✗
user_ids	array	Danh sách user_id	✗
body.text	string	Nội dung văn bản	✓
body.metadata[0].type	string	Phải là "quick_reply"	✓
body.metadata[0].quick_reply.items	array	Danh sách lựa chọn, tối đa 10 phần tử.	✓

note

• Bắt buộc thread_id hoặc ext_user_ids hoặc user_ids phải có dữ liệu.
• Đích đến của tin nhắn sẽ được ưu tiên theo thứ tự thread_id, ext_user_ids, user_ids.
• ext_user_ids tối đa 1000 phần tử.
• user_ids tối đa 100 phần tử.
• Metadata chỉ có 1 phần tử

Giải thích các thuộc tính của items:

Tên	Kiểu dữ liệu	Mô tả	Bắt buộc
items[i].label	string	Nội dung hiển thị	✓
items[i].action.type	int	1:uri xử lý ở phía client như gọi điện hoặc gửi email hoặc đi đến url được config ở payload, 2: gửi text và đẩy lại thông tin của payload qua webhook_url của bot đã được thiết lập, 3: chỉ gửi text vào cuộc hội thoại.	✓
items[i].action.payload	string	Dữ liệu tương ứng với action.type: 1 hoặc 2	✗

Response

Nếu thành công, bạn sẽ nhận được phản hồi.

Ví dụ

{
    "message_code": "M200",
    "message": "Success"
}

Tên	Kiểu dữ liệu	Mô tả
message_code	string	Mã thông điệp. Xem chi tiết
message	string	Nội dung mã thông điệp